opto8 2.2.0
Loading...
Searching...
No Matches
opto8.h File Reference

This file contains API for Opto 8 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"

Go to the source code of this file.

Data Structures

struct  opto8_t
 Opto 8 Click context object. More...
struct  opto8_cfg_t
 Opto 8 Click configuration object. More...

Macros

#define OPTO8_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  opto8_return_value_t { OPTO8_OK = 0 , OPTO8_ERROR = -1 }
 Opto 8 Click return value data. More...

Functions

void opto8_cfg_setup (opto8_cfg_t *cfg)
 Opto 8 configuration object setup function.
err_t opto8_init (opto8_t *ctx, opto8_cfg_t *cfg)
 Opto 8 initialization function.
void opto8_set_out1 (opto8_t *ctx)
 Opto 8 set OUT1 function.
void opto8_clear_out1 (opto8_t *ctx)
 Opto 8 clear OUT1 function.
void opto8_toggle_out1 (opto8_t *ctx)
 Opto 8 toggle OUT1 function.
void opto8_set_out2 (opto8_t *ctx)
 Opto 8 set OUT2 function.
void opto8_clear_out2 (opto8_t *ctx)
 Opto 8 clear OUT2 function.
void opto8_toggle_out2 (opto8_t *ctx)
 Opto 8 toggle OUT2 function.
uint8_t opto8_get_in1 (opto8_t *ctx)
 Opto 8 get IN1 function.
uint8_t opto8_get_in2 (opto8_t *ctx)
 Opto 8 get IN2 function.

Detailed Description

This file contains API for Opto 8 Click Driver.

Enumeration Type Documentation

◆ opto8_return_value_t

Opto 8 Click return value data.

Predefined enum values for driver return values.

Enumerator
OPTO8_OK 
OPTO8_ERROR